home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 26 / CU Amiga Magazine's Super CD-ROM 26 (1998)(EMAP Images)(GB)[!][issue 1998-09].iso / CUCD / PowerPC / uae-0.8.4 / docs / README < prev    next >
Text File  |  1998-06-03  |  34KB  |  743 lines

  1. This is version 0.8.4 of UAE, the Un*x Amiga Emulator.
  2.  
  3. Versions numbered 0.8.x are beta versions, to be used for development only.
  4. If you are only a user of UAE, you are better off using the latest 0.7.x
  5. version or waiting for 0.9.0.
  6.  
  7.  
  8. License
  9. =======
  10.  
  11. UAE is available under the terms of the GNU General Public License. This means
  12. that it is free software: you are welcome to distribute copies of it and/or
  13. modify it, under certain conditions. It also means that there is no warranty
  14. for UAE.
  15. See the file COPYING that is included in the top level directory of this
  16. archive for details.
  17.  
  18.  
  19. Overview
  20. ========
  21.  
  22. An emulator is a program which enables you to run software for a machine
  23. which has non-native hardware and a non-native operating system, on your
  24. computer.  UAE allows you to run most of the available Amiga software. It is a
  25. software emulation, meaning that no extra or special hardware is needed to do
  26. this. The hardware of an Amiga is emulated accurately, so that Amiga software
  27. is tricked into thinking it is running on the real thing, with your computer's
  28. display, keyboard, harddisk and mouse taking the parts of their emulated
  29. counterparts.
  30.  
  31. UAE was developed for Unixoid systems. Meanwhile, it has been ported to the
  32. Mac, DOS, the BeBox, NextStep, the XFree86/OS2 environment and the Amigas (it
  33. can run itself by now). You should have received several other files along
  34. with this document with details on how to install and use the version for your
  35. operating system.
  36.  
  37. This section is just what it says: an overview. Please read _all_ of this
  38. file, especially if you have problems. UAE has many, many features and
  39. equally many configuration options. If you don't know about them, it's likely
  40. that UAE doesn't work for you, or doesn't work as good as it could.
  41.  
  42. Please read also the file "FAQ" which contains some Frequently Asked
  43. Questions (and even the answers!) You should also look for a document
  44. describing the specific port of UAE to the operating system you are using,
  45. for example "BeOS/README" or "DOS/README".
  46.  
  47. People have complained that the UAE documentation contains only "weird jargon".
  48. Sorry about this. Despite what MessySoft and Tomato tell you, computer
  49. programs aren't always easy to use. UAE does require some assistance from you,
  50. and therefore you should at least understand a bit about computers. After all,
  51. you are an Amiga fan, so you should know what a Workbench is, don't you think?
  52.  
  53.  
  54. Features
  55. ========
  56.  
  57. This version of UAE emulates:
  58.  
  59. - A 68000, 68010 or 68020 CPU, optionally a 68881 FPU
  60. - OCS Graphics Chipset, plus big blits from the ECS Chipset
  61. - Up to 2MB Chip RAM and up to 8MB Fast RAM, or 8MB Chip RAM without Fast RAM
  62. - Up to 64MB Zorro III Fast RAM, independent of Chip RAM setting (68020 only)
  63. - Up to 1MB Slow RAM, for extended compatibility with problem software
  64. - Up to 8MB of graphics card memory, usable by software that supports
  65.   Picasso 96 compatible graphics cards
  66. - 4 x 3.5" floppy disk drives (DF0:, DF1:, DF2: and DF3:). It's not possible to
  67.   read Amiga disks, so these are emulated with disk files.
  68. - A hard-disk: either a harddisk image file or part of the native filesystem
  69. - Joystick support (with option of mapping joystick to numeric keypad)
  70. - Mouse support
  71. - Ability to run in various screen modes (for better display quality or
  72.   better speed)
  73. - Full stereo sound support, consisting of 4 x 8bit channels
  74. - Beta parallel and serial port support
  75. - some other things which don't work well enough to mention them here...
  76.  
  77.   
  78. Requirements (IMPORTANT! READ THIS!)/Limitations
  79. ================================================
  80.  
  81. Not emulated:
  82. - Sprite to playfield collisions (sprite to sprite collisions work)
  83. - An MMU (part of 68030/040 CPUs except those that Commodore used). This means
  84.   you can't use virtual memory systems or real operating systems like Linux
  85.   or BSD.
  86. - The AGA chipset (A4000/A1200). This chipset has enhanced capabilites for
  87.   up to 256 colors in all resolutions.
  88. - Serial port emulation exists but doesn't work too well (someone tell me when
  89.   that's no longer true, I don't use it).
  90.  
  91. Since the PC floppy controller can't read Amiga disks (yes, that's a fact), 
  92. floppy access has to be emulated differently: Floppies are emulated by means 
  93. of disk files that contain a raw image of the floppy disk you want to emulate.
  94. A disk file is an image of the raw data on an Amiga floppy disk, it contains
  95. 901120 bytes (880K), which is the standard capacity of an Amiga disk.
  96.  
  97. To actually run the program, you'll need to install the ROM image from your
  98. Amiga. You can't run UAE if you don't have this image. It is not included
  99. because it is copyrighted software. Don't ask me to send you one. I won't.
  100. If you don't have an Amiga and still want to use UAE, you'll have to buy an
  101. Amiga or at least the system software (ROM + Workbench) first.
  102. The Kickstart image can have a size of either 256K or 512K. It must be named
  103. "kick.rom" by default.
  104.  
  105. Read the section "tools" below for information how to create ROM images and
  106. disk files.
  107.  
  108. If you don't have a Kickstart file, you may still be able to boot some games
  109. and demos. The emulator includes some primitive bootstrap code that will try
  110. to read and execute the bootblock of the diskfile you are using, and if that
  111. bootblock only uses the one or two Kickstart functions that are supported by 
  112. the "replacement Kickstart", your program will boot. Don't expect too much, 
  113. though.
  114.  
  115. You'll also need some other software to run - why else would you want to
  116. emulate an Amiga? There are several ways to make the software accessible to
  117. UAE, either with disk image files or with a harddisk emulation. You should
  118. make an image of your Amiga's Workbench disk and install it as "df0.adf"
  119. (adf = Amiga Disk File) when you use UAE for the first time. More about how
  120. to create these files in the chapter "Transferring software"
  121.  
  122. To use Picasso96 emulation, you need the Picasso96 libraries, which are also
  123. not included. They can be obtained (e.g.) from Aminet.
  124.  
  125.  
  126. Invoking UAE
  127. ============
  128.  
  129. First, read the system-specific documents for information how to set up UAE.
  130. You should have an executable program called "uae". You can simply execute it,
  131. but you can also optionally give it one or more of the following options:
  132.  
  133. General options:
  134.  -h      : Give help on the options.
  135.  -A n    : Set emulator accuracy to n. The default is n = 2, which means the
  136.            emulator will try to be as accurate as possible. This no longer
  137.        does much in this version, and I'll probably remove it.
  138.  -f n    : Sets the frame rate to 1/n. Only every nth screen will be drawn.
  139.  -a      : Add no expansion devices. This will disable fastmem and harddisk
  140.            emulation, but some extremely badly-written games may need this.
  141.        (Kickstart 1.2 needs it, too)
  142.  -l lang : Set the keyboard language. Currently, the following values can be 
  143.        used for lang: "us" for U.S. keyboard (default), "se" for swedish, 
  144.        "fr" for french, "it" for italian, "es" for spanish, or "de" for
  145.        german keyboard.
  146.        This setting only affects the X11 version.
  147.  -0 file : Try to use file as diskfile for drive 0 instead of df0.adf.
  148.            The options -1, -2 and -3 also exist for the other drives.
  149.  -r file : Use file instead of kick.rom as Kickstart image.
  150.  -J xy   : Specify how to emulate joystick port 0 (x) and 1 (y). Both x and y
  151.            can be one of the following characters: 0 = joystick 0, 1 =
  152.            joystick 1, M for mouse, and a, b or c stand for various keyboard
  153.        replacements (a is the numeric pad with '0' as fire button, b the
  154.        cursor keys with right control as fire button and c is T/F/H/B with
  155.        Alt as fire button.
  156.        The default is "-J M0" (mouse and joystick as usual)
  157.  -G      : Disable the user interface (if present).
  158.  -n specs: Set blitter emulation. "specs" is a string of characters. If it
  159.            contains a "3", the blitter will use 32 bit operations where that
  160.        seems profitable (note that this will cause bus errors on most
  161.        RISC machines). If you specify "i", all blits will finish 
  162.        immediately, which can be nice for speed. To enable both options,
  163.        say "-n 3i"
  164.  -w n    : Set CPU emulation speed to n. The default value is 4; higher values
  165.            will give the custom chip emulation a higher priority over the CPU,
  166.        but some programs crash if this is higher than 4. Setting it to 1
  167.        is a good way to make the emulator run slower on machines which are
  168.        too fast.
  169.  -C specs: Controls how the CPU is emulated. The first letter must be '0' for
  170.            68000 emulation, '1' for 68010, '2' for 68020 or '3' for
  171.        68020 + 68881. It can be followed by a 'c', which enables a slower
  172.        but more compatible version of 68000 emulation, or by an 'a', which
  173.        enables a 24 bit address space for 68020 emulation. Normally you
  174.        don't want either; use the more compatible emulation if some game or
  175.        demo does not work. The 24 bit address space option appears to be
  176.        necessary for some Kickstart ROMs, so try that if things don't work
  177.        at all.
  178.  
  179. Emulating external devices (harddisk, CD-ROM, printer, serial port):
  180.  -M VOLUME:path
  181.  -m VOLUME:path
  182.            Mount the unix file system at "path" as an Amiga filesystem with
  183.        volume name "VOLUME:". For example, "-M sound:/usr/amiga/modules"
  184.        If you use -M instead of -m, the volume will be read only. Use this
  185.        for mounting CD-ROMs. See below.
  186.  -W secs:heads:nr:file
  187.            Mount the hardfile "file" as an emulated harddisk, using a geometry
  188.        of "secs" sectors per track, "heads" surfaces and "nr" reserved
  189.        blocks. Can be abused to mount floppy images. See below.
  190.  -p cmd  : Enable printing. See below.
  191.  -I dev  : Use "dev" as serial device (e.g. /dev/ttyS1 on Linux).
  192.  
  193. Sound options:
  194.  -S specs: If your version of UAE supports sound, this option allows you to
  195.        tell the emulator how to produce sound. The specs parameter is
  196.        made up as follows:
  197.        n:stereo:bits:frequency:minimum buffer size:maximum buffer size
  198.            You can use one of the following values for "n":
  199.        n = 0: No proper sound emulation at all. May be incompatible 
  200.               (unlikely). This is the default.
  201.        n = 1: Emulate the sound hardware, but don't output sound. May be
  202.               needed for compatibility, but can be much slower
  203.        n = 2: Emulate the sound hardware and output sound. Recommended.
  204.        n = 3: Emulate the sound hardware _exactly_. I don't think you'll
  205.               hear a difference. SIDmon modules will be emulated 
  206.           correctly, but painfully slow with this setting.
  207.           Unfortunately, this may also be needed to get some programs
  208.           to work (AIBB, for example).
  209.        Use either 's' or 'm' to set the "stereo" value.
  210.        For "bits", common values are 8 (low quality) or 16 (high quality).
  211.        For "frequency", common values are 22050 or 44100. The quality of
  212.        sound output increases with the frequency.
  213.        You can specify the minimum and maximum size of the sound buffer.
  214.        Smaller buffers reduce latency.
  215.        You don't need to specify all of the options, you can stop after
  216.        each subpart. Examples: "-S0" (sound off), "-S2:s" (sound on, 
  217.        stereo), "-S3:m:16:44100" (complete emulation, mono, 16 bits,
  218.            44100 Hz).
  219.        Note: high quality sound requires a lot of computing power, so try
  220.        with different settings if your machine is not fast enough.
  221.  
  222. Memory options:
  223.  -s n    : Emulate n*256K slow memory at 0xC00000. Some demos/games need this.
  224.  -F n    : Emulate n megabytes of fast memory as an expansion board.
  225.  -Z n    : Emulate n megabytes of Zorro III fast memory as an expansion board.
  226.  -c n    : Emulate n*512K chip memory. The default is 2MB chipram. Some very
  227.            broken programs need "-c 1" to work properly. The largest legal
  228.        value is "-c 16", which means 8MB chip memory.
  229.  -4 n    : Usually, UAE uses a 24 bit address space when it emulates a 68000,
  230.            and a 32 bit address space when it emulates a 68020. If n is 1,
  231.        this option turns on a 24 bit address space in 68020 emulation. It
  232.        appears to be necessary for some Kickstart images. Careful: this
  233.        option has harmful side effects, and should be disabled by default.
  234.  
  235. Debugging options (not interesting for most users):
  236.  -D      : Don't start the emulator at once, use the built-in debugger.
  237.  -i      : Print illegal memory accesses
  238.  
  239. Display options:
  240.  -H mode : Select a color mode to use.
  241.  -O specs: Select a display mode, see below how the specs parameter is
  242.            interpreted.
  243.  -U n    : Emulate a Picasso 96 compatible graphics card with n MB graphics
  244.            memory.
  245.  
  246. Color modes: 0 (256 colors, default); 1 (32768 colors); 2 (65536 colors)
  247.              3 (256 colors, with dithering to improve color quality)
  248.          4 (16 colors, dithered); 5 (16 million colors)
  249.  
  250. About the "-O" display specs. These consist of the width and height of the
  251. mode, plus optional modifiers. One valid option to pass to UAE would be
  252. "-O 640:300:" which means use a display 640 pixels wide and 300 pixels high,
  253. with no modifiers (nothing after the second ":"). You may specify the
  254. following modifiers:
  255.  l: Tell UAE to omit drawing every second pixel horizontally (for "lores"
  256.     modes). Example: "-O 320:200:l"
  257.  x: Tell UAE to try to fit the image horizontally into the displayed
  258.     window. For example, if you have a mode that is 640 pixels wide, and the
  259.     displayed image is also 640 pixels wide, the picture may still be
  260.     partially invisible because it is displayed too wide to the left or to
  261.     the right. With the "x" modifier, UAE tries to prevent this.
  262.     You can also specify a capital "X", in that case, UAE tries to be
  263.     extremely clever when doing this.
  264.  y: The same thing in green, for fitting the image vertically into the
  265.     window. (Y also exists)
  266.  d: Draw every line twice. This allows interlace mode to be emulated nicely,
  267.     but of course you also need a display that is twice as high
  268.  c: Correct the aspect. This will omit certain lines of the display to make
  269.     it fit better into the screen.
  270.  
  271. Whew. You'll probably have to experiment a little to get a feeling for it.
  272.  
  273.  
  274. UAE may choose to ignore and/or refuse some combinations of these two
  275. parameters. Some of these modes may also fail to work on your system.
  276.  
  277. You can also put these options into a configuration file in your home
  278. directory. Simply create ~/.uaerc and put some of these options in it. On
  279. non-Unix systems, the file is called uae.rc and should be located in the
  280. current directory.
  281.  
  282.  
  283. Choosing color and screen modes
  284. ===============================
  285.  
  286. As described in the previous paragraph, UAE can run in many different 
  287. resolutions and color modes. However, few of the color mode options are
  288. available if you use the X11 version of UAE, since the X server determines
  289. how many colors are available. If you are running a 256 color X server, you
  290. can use "-H3" to tell UAE to dither the colors for better results.
  291.  
  292. You will have to experiment which mode gives the best results for you at a
  293. satisfying speed. Note that the dithering process consumes time, so even if
  294. 256 colors with dithering look better than 256 colors without, remember that
  295. UAE will be slower in that mode.
  296.  
  297. The recommended resolution is 800x600. In the lower resolution modes, some
  298. overscan pictures the Amiga tries to display may not fit entirely on the
  299. screen, others may be off-center and some graphical effects may look weird.
  300. For best results, use 800x600 with at least 32768 colors.
  301. For speed, use 400x300 lores with 256 colors.
  302.  
  303. _Don't_ use 24 bit or 32 bit screen modes, unless you absolutely have to.
  304. These are way too slow to be usable.
  305.  
  306.  
  307. Harddisk emulation
  308. ==================
  309.  
  310. Since using diskfiles is awkward, it is necessary to emulate harddisks. There
  311. are two ways how you can use large amounts of data with UAE: harddisk files
  312. and mounted directories.
  313.  
  314. 1. Harddisk files
  315.  
  316. Harddisk files are large files that contain the image of an Amiga filesystem.
  317. They work much the same way as a disk file. You can simply create a large
  318. empty file and tell UAE to use it as a hardfile, but you will need to format
  319. it from the emulation before you can actually use it.
  320.  
  321. Under Unix, You can create a (unformatted) harddisk file with
  322.   dd if=/dev/zero of=hardfile bs=512 count=16384
  323. That will create an 8MB file. Other ports of UAE may come with a utility
  324. called "makedisk" or other ways to create such a file.
  325.  
  326. To tell the emulator that you want to use a certain file as a hardfile, use
  327. the "-W" option, for example
  328.   uae -W 32:1:2:hardfile
  329. The first three numbers are geometry information which tell the AmigaOS how
  330. the file is organized. The first number (32) is the number of sectors per
  331. track, the second number (1) is the number of heads or surfaces, the third
  332. number (2) is the number of reserved blocks. If you use "normal" sizes
  333. (powers of two, like 32MB), then you should be OK using the same numbers as
  334. in the above example. Using different numbers can make sense if you transfer
  335. the image of a real Amiga harddisk which uses a different geometry. The last
  336. field of the argument to the "-W" option is the name of the harddisk file.
  337.  
  338. If you are using Kickstart 1.3 or earlier, hardfiles can't currently be
  339. mounted at boot time, and therefore you can't boot from it either. You will
  340. have to boot either from a floppy disk image or from a filesystem (see below),
  341. and mount the hardfile.device later. To do this, add the following to
  342. "DEVS:mountlist":
  343.  
  344. UAE0:       Device = uaehf.device
  345.        Unit   = 0
  346.        Flags  = 0
  347.        Surfaces  = 1
  348.        BlocksPerTrack = 32
  349.        Reserved = 1
  350.        Interleave = 0
  351.        LowCyl = 0  ;  HighCyl = 511
  352.        Buffers = 5
  353.        DosType = 0x444F5300
  354.        BufMemType = 1
  355. #
  356.  
  357. (You may need to adjust the values if you specified a different geometry,
  358. and/or your hardfile has a different size than 8MB, and/or the hardfile is not
  359. mounted as UAE0: because you mounted other harddisks before it.)
  360.  
  361. Then, type "mount UAE0:" (or put that command in your startup-sequence), and
  362. you should be able to access it. Don't forget to format it with the AmigaDOS
  363. format command:
  364.  
  365.   format drive uae0: name Mister_Willwink
  366.  
  367. b) Accessing native filesystems from the emulator
  368.  
  369. This has some major advantages:
  370.  - It has no problems with Kickstart 1.3
  371.  - It is more convenient.
  372.  - It is much faster.
  373.  
  374. If you specify the -M or -m command line arguments, you your native filesystem 
  375. from the emulator. If you start UAE with
  376.  
  377.   uae -m sound:/usr/amiga/modules
  378.  
  379. you can access all the files in /usr/amiga/modules by reading from the
  380. AmigaDOS volume "SOUND:".
  381. (DOS users: try "uae -m dh0:C:\" to mount your drive C:\ as DH0:)
  382.  
  383. You can mount up to 20 devices, either hardfiles or filesystems, by giving
  384. either of these options multiple times. The volumes will be named UAE0:,
  385. UAE1:, etc. UAE will boot from UAE0: if no diskfile is found for floppy
  386. drive 0.
  387. You can also use native filesystems to mount Amiga CD-ROMs, and you can
  388. abuse the hardfile emulation to mount floppy disks: "uae -W 11:2:2:wb13.adf"
  389. will mount the diskfile "wb13.adf".
  390.  
  391.  
  392. Tools / Transferring files
  393. ==========================
  394.  
  395. As you should know by now, you need to transfer files between your Amiga and
  396. the machine you run UAE on. There are several ways how to do this.
  397.  
  398. - Using a null modem cable, and a terminal package running on each machine,
  399.   you can transfer the file(s) via Zmodem upload/download. 68000 equipped
  400.   Amigas can normally attain around 3000cps through the null modem cable,
  401.   using the standard Commodore serial.device.  However, by using the device
  402.   replacement BaudBandit.device, anything up to 5500cps can be attained.
  403.   BaudBandit can be obtained from Aminet.  A second alternative is to use
  404.   the BASIC program adfi.bas (included with UAE) to transfer a file from the
  405.   Amiga to the PC via the null modem cable.
  406.   
  407. - If you're using CrossDOS on your Amiga, you can compress the disk or
  408.   kickstart image using LhA or similar PC compatible archiver and copy it to
  409.   a 720KB floppy disk.  You can now take the disk over to the PC, copy the
  410.   compressed file to the UAE directory and uncompress it.
  411.   If you don't have CrossDOS on the Amiga, there is a similar freeware tool
  412.   called Msh, which can be found on Aminet or on Fish disk 382 or 327.
  413.  
  414. In either case, you ought to read the documentation for the programs that
  415. you use for the transfer. These programs can't be explained here.
  416.  
  417. In the "amiga" subdirectory you'll find two small Amiga programs that will
  418. help you to generate the necessary image files. These are called transrom 
  419. and transdisk. Copy them to your Amiga and make them executable (by typing
  420. "protect transrom rwed" and "protect transdisk rwed" in the Amiga shell
  421. window).
  422. transrom will dump the contents of your Kickstart ROM, and transdisk will 
  423. dump an image of a floppy in one of the drives. Both programs write to the
  424. standard output (read: the screen), so you'll want to redirect that. Do
  425.  
  426.    transrom >ram:kick.rom
  427.    
  428. to create a file called "kick.rom" in the RAM disk, and
  429.  
  430.    transdisk >ram:df0.adf
  431.    
  432. to create a file called "df0.adf" in the RAM disk. These files are pretty
  433. big, 262144 or 524288 bytes for the ROM image and 901120 bytes for a disk 
  434. image.
  435.  
  436. NEVER run either of these programs from the Workbench. Always open a Shell
  437. or CLI window to do this.
  438.  
  439. transdisk understands the following arguments:
  440.  
  441.     -d device unit: Use this device instead of DF0:
  442.     -s n:           Begin transfer at track n (default: 0)
  443.     -e n:           End transfer at track n (default: 79)
  444.     -w file:        don't read from the floppy, instead write the contents
  445.                     of "file" to the floppy
  446.     -h:             Treat the disk as high-density disk. HD images aren't
  447.                     supported by UAE yet, though. Note that the resulting
  448.             file will be twice as big.
  449.  
  450. So, to transfer the disk in drive DF1:, you'd give the command:
  451.  
  452.   transdisk >ram:df1.adf -d trackdisk 1
  453.  
  454. If you don't have much RAM and can't fit all of a disk image in the RAM disk,
  455. you can split up the transfer into multiple parts with the "-s" and "-e"
  456. parameters. To transfer the disk in four parts, you'd use the following 
  457. commands:
  458.   
  459.   transdisk >ram:df0_1.adf -s 0 -e 19
  460.   transdisk >ram:df0_2.adf -s 20 -e 39
  461.   transdisk >ram:df0_3.adf -s 40 -e 59
  462.   transdisk >ram:df0_4.adf -s 60 -e 79
  463.  
  464. Of course, you should save each of the four files to another place before
  465. transferring the next one with transdisk to make space in your RAM disk. 
  466. If you have all the files on your PC, you can do the following under Unix:
  467.   cat df0_1.adf df0_2.adf df0_3.adf df0_4.adf >df0.adf
  468. or, under DOS:
  469.   COPY /B df0_1.adf+df0_2.adf+df0_3.adf+df0_4.adf df0.adf
  470. I've been told there are the following tools for the Mac to join binaries:
  471. "ChunkJoiner 2.1.2" found under Info-Mac's <disk> directory or 
  472. "JoinFiles 1.0.1" under Info-Mac's <text>.
  473.  
  474. The current transdisk can only read the standard AmigaDOS format. This means
  475. that most games that rely on some form of copy-protection cannot be
  476. transferred (more about disk formats in the file "FAQ")
  477.  
  478. ****************************************************************************
  479. If you transfer commercial software, you must not distribute the resulting
  480. image files, since that would be a violation of copyright law. The Kickstart
  481. ROM has to be considered commercial software. You may only use the Kickstart
  482. from your own Amiga, and you may not distribute Kickstart ROM files.
  483. Please read the license that came with your software for details.
  484. ****************************************************************************
  485.  
  486.  
  487. Retrieving files from a disk image
  488. ==================================
  489.  
  490. If you have a disk image file, and you want to retrieve the files from it, you
  491. can use the "readdisk" tool. It is automatically built by "make". If you have
  492. a disk image of a disk called "Workbench1.3D" as df0.adf, and you do
  493.    readdisk df0.adf
  494. the whole directory structure of the disk image will be stored in a newly
  495. created subdirectory called "Workbench1.3D". You can optionally give a second
  496. parameter to specify a directory where to create the output other than the
  497. current directory.
  498. readdisk only understands about the OFS right now. FFS disks will cheerfully
  499. be regarded as being unreadable. Use the unixfs.device from within the
  500. emulator if you want to transfer files from FFS disks.
  501.  
  502.  
  503. Picasso 96 graphics card emulation
  504. ==================================
  505.  
  506. To use this feature, you must select 68020 emulation with a 32 bit address
  507. space. You also need a Kickstart 3.x ROM.
  508.  
  509. To specify how much graphic memory you want to emulate, use the "-U" option,
  510. e.g. "-U 4" for 4 megabytes. Then, you need the Picasso 96 software which
  511. is not distributed with UAE (There will be a link to the Picasso 96 home page
  512. on the UAE Web page soon). Version 1.31 or higher is recommended.
  513. Install the Picasso software, and make sure you enable the "uaegfx" driver.
  514. After that is complete, reboot, and you should be able to select the new
  515. modes from the ScreenModes program.
  516.  
  517.  
  518. The UAE_CONTROL program
  519. =======================
  520.  
  521. In the "amiga" subdirectory, you will find two programs, uae_control and
  522. uaectrl that provide the same functionality as the X11 GUI. uaectrl is
  523. shell-based and works with any Kickstart, while uae_control needs the
  524. gadtools.library and a recent version of reqtools.library, so it only works
  525. with Kick 2.0 and upwards. Copy these two programs to the directory that you
  526. use for harddisk emulation. They should be self-explanatory.
  527.  
  528.  
  529. Quick overview of the debugger commands
  530. =======================================
  531.  
  532. Some (window-system based) ports of UAE have a built-in debugger. You can
  533. press ^C at any time to enter this debugger.
  534. Each debugger command consists of a single letter and occasionally some
  535. parameters.
  536.  
  537. g:                    Start execution at the current address. 
  538. c:                    Dump state of the CIA and custom chips.
  539. r:                    Dump state of the CPU
  540. m <address> <lines>:  Memory dump starting at <address>
  541. d <address> <lines>:  Disassembly starting at <address>
  542. t:                    Step one instruction
  543. z:                    Step through one instruction - useful for JSR, DBRA etc.
  544. f <address>:          Step forward until PC == <address>
  545. q:                    Quit the emulator. You don't want to use this command.
  546. M:                    hunt for sound modules
  547. S <filename> <address> <len>:
  548.                       save a sound module
  549.  
  550.  
  551. Sound
  552. =====
  553.  
  554. If your version of UAE supports sound, you can pass parameters like frequency
  555. or number of bits to use on the commandline; if you don't specify any, sane
  556. defaults will be used. If graphics output is enabled while sound is output,
  557. the emulator will be much too slow on most systems. The sound will not be
  558. continuous. Therefore, a hack to turn off screen updates is provided: Press
  559. ScrollLock to disable graphics, press it again to enable them.
  560.  
  561. The quality of the emulation depends on the setting of the "-S" commandline
  562. option. With "-S 3", all of the sound hardware is emulated; and some programs
  563. (e.g. AIBB) won't run with other settings. "-S 2" should sound just as good as
  564. "-S 3" and will be much faster for some programs. "-S 1" tries to emulate most
  565. of the sound hardware, but doesn't actually output sound. "-S 0" completely
  566. turns off sound.
  567.  
  568.  
  569. Pointers
  570. ========
  571.  
  572. There are a few sites in the Internet that contain helpful information about
  573. UAE.
  574.  
  575. The new "official" UAE page is located at
  576.  
  577. http://www.freiburg.linux.de/~uae
  578.  
  579. thanks to Stefan Reinauer who is now maintaining it.
  580.  
  581. There, you will find links to other UAE pages. One which is especially useful
  582. is the "UAE Discussion Board" set up by Gustavo Goedert, the address is
  583.  
  584. http://www.netrunner.com.br/dosuae/uaeboard/index.html
  585.  
  586. Not quite as good as a newsgroup due to braindamaged reader software
  587. (Ratscope), but still a blessing.
  588.  
  589. There is supposedly a newsgroup named "alt.emulators.amiga", but I don't get
  590. it here.
  591. The newsgroup "comp.sys.amiga.emulations" appears to be a proper place to
  592. discuss Amiga emulation, but, strictly speaking, it is _not_ the right place.
  593. More appropriate places are "comp.emulators.misc", and, of course, Gustavo's
  594. discussion board.
  595.  
  596. Petter Schau has written another Amiga emulator named "Fellow".  It's mostly
  597. written in x86 assembly and only runs under DOS.  It's quite compatible and
  598. generally faster than UAE.  The Fellow homepage is at
  599.  
  600. http://www.geocities.com/SiliconValley/Peaks/5244/
  601.  
  602.  
  603. Thanks & Acknowledgements
  604. =========================
  605.  
  606. Thanks to all who have written me so far with bugreports and success/failure
  607. reports when trying to run the emulator on various hardware with different
  608. Kickstart versions. A list of everyone who has contributed to the source code
  609. can be found in the CREDITS file (this was getting too big to keep it here).
  610.  
  611. Special thanks to:
  612.   - Jay Miner, Dale Luck, R.J. Mical and all the others who built the Amiga.
  613.   - Felix Bardos, whose HRM I "borrowed".
  614.   - Hetz Ben Hamo mailed Peter Kittel from Commodore asking for permission to
  615.     give Kick 1.3 away. Unfortunately, the response was negative :-(
  616.   - Stefan Reinauer, for hosting the UAE Web page after the RWTH decided it's
  617.     too dangerous to let students have their own Web pages.
  618.   - Bruno Coste, Ed Hanway, Alessandro Soldo and Marko Nippula provided useful
  619.     documentation about the Amiga
  620.   - Fabio Ciucci gets the "Best bug reports" award for his help with the
  621.     blitter line emulation and other problem areas.
  622.   - Michael C. Battilana and Cloanto Software, for all their support.
  623.   - Julian Eggebrecht of Factor 5, for providing several F5 games and a lot
  624.     of valuable input.
  625.     Factor 5 has made Katakis, one of their classic Amiga games, freely
  626.     available for download. There are still some good people left in the
  627.     world...
  628.  
  629.  
  630. Authors/Maintainers
  631. ===================
  632.  
  633. My address is (please read the section "Before you send email" below):
  634.  
  635. crux@pool.informatik.rwth-aachen.de
  636.  
  637. or, via snailmail
  638.  
  639. Bernd Schmidt
  640. Schlossweiherstrasse 14
  641. 52072 Aachen
  642. Germany
  643.  
  644. Email is more likely to be answered, and will definitely be answered much
  645. faster. Please avoid phonecalls if you can.
  646. I won't distribute software, neither PD or commercial. Don't send me floppy
  647. disks without at least asking first, you will not get them back.
  648.  
  649. The following people have ported UAE to different platforms; you should
  650. direct system-specific questions to them:
  651.  
  652. DOS port:
  653.   Gustavo Goedert <ggoedert@netrunner.com.br>
  654.   Available: http://www.netrunner.com.br/dosuae
  655.   Sourecode: available on the above Web page, most of it included in the
  656.              main source (with some delay)
  657.  
  658. Mac port:
  659.   Originally: Ernesto Corvi <someone@imagina.com>
  660.   Currently: Arnaud Blanchard <jblancha@pratique.fr>
  661.   Available: http://www.pratique.fr/~jblancha/
  662.   Sourcecode: extra package available. Bits and pieces in the main source,
  663.               but nothing you could get to compile.
  664.  
  665. BeBox port:
  666.   Christian Bauer <bauec002@goofy.zdv.uni-mainz.de>
  667.   Available: The main UAE web page (use the Unix sources)
  668.   Sourcecode: Included in the main source. Should compile OK.
  669.   Notes: Christian says he doesn't have much time to spend on UAE, so if
  670.          anyone is willing to help maintain this port, please speak up.
  671.  
  672. NextStep port:
  673.   Ian Stephenson <ians@cam-ani.co.uk>
  674.   Available: The main UAE web page (use the Unix sources)
  675.   Sourcecode: Included in the main source. Should compile OK.
  676.   Notes: Ian says he doesn't have much time to spend on UAE, so if
  677.          anyone is willing to help maintain this port, please speak up.
  678.  
  679. Amiga port:
  680.   Originally: Olaf 'Olsen' Barthel <olsen@sourcery.han.de>
  681.   Currently: Samuel Devulder <devulder@info.unicaen.fr>
  682.   Available: Not quite sure yet. Paul Liss' Web page has binaries.
  683.   Sourcecode: Included in the main source. Should compile OK.
  684.  
  685. pOS port:
  686.   Samuel Devulder <devulder@info.unicaen.fr>
  687.   Available: Not quite sure yet.
  688.   Sourcecode: Included in the main source. Should compile OK.
  689.   
  690. XFree86/OS2 port:
  691.   Krister Bergman <bellman@kuai.se>
  692.   Available: http://www.kuai.se/~bellman/html/xfreeapps.html
  693.   Sourcecode: nothing special, apparently the Unix stuff compiles cleanly (?)
  694.  
  695. Win32 port:
  696.   Mathias Ortmann <ortmann@informatik.tu-muenchen.de>
  697.   Brian King <Brian_King@codepoet.com>
  698.   Available: http://www.informatik.tu-muenchen.de/~ortmann
  699.              http://www.codepoet.com/uae
  700.   Sourcecode: we're working on it
  701.  
  702. Acorn RISC PC port:
  703.   Peter Teichmann <sol@Space.WH1.TU-Dresden.De>
  704.   Available: http://www.wh1.tu-dresden.de/~sol/acorn.shtml
  705.              http://www.wh1.tu-dresden.de/~sol/acorne.shtml
  706.   Sourcecode: Some of it is included in the main source, but since Acorn's OS
  707.               apparently doesn't have decent file handling, you can't even
  708.           use the same source layout. Also needs lots of additional files.
  709.           
  710. Since I generally don't have the possibility to test or improve these ports,
  711. it is a good idea to contact their respective authors if you have questions.
  712.  
  713.  
  714. Before you send email...
  715. ========================
  716.  
  717. Before you contact me with a problem that you have, make sure you have read
  718. _all_ of the above. Please read also the file "FAQ", which contains a lot of
  719. helpful information, and the README file for your specific system. 
  720.  
  721. I can't answer _every_ question. If you have trouble understanding this
  722. README, either because you don't speak English very well or because you have
  723. no clue at all about computers, please try to find some friend of yours who 
  724. does understand this file and who can translate/explain it for you. I simply
  725. can't explain (for example) how to use terminal programs or CrossDOS because
  726. I don't use either, and it would be much too time-consuming anyway. This file
  727. and the file FAQ contains about every piece of information I can give you. I 
  728. try to help people who have questions, but sometimes it takes too much time.
  729.  
  730. Please don't ask for Kickstart ROM files or other copyrighted software. Don't
  731. _send_ me stuff like this either. If you want to send me something else which
  732. is big (>= 50K), ask me before or put it somewhere in Webspace.
  733. If I get 3MB of screen shots or a core dump ("it doesn't work, it generates
  734. this file"), I'm very likely to get extremely angry, I might complain to your
  735. sysadmin, and you might lose your account. Think twice.
  736.  
  737. I'm also going to be extremely annoyed if you send email in HTML format.
  738. Fight this disease!
  739.  
  740. Oh, and another thing: If I promise to do things (like implement new
  741. features), and forget about them, pester me. That happens occasionally, it's
  742. a known bug in my brain. I'll have it replaced.
  743.